Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[1.42.x] KOGITO-9460: Create a new guide describing the workflow CLI #483

Merged
merged 5 commits into from
Oct 5, 2023

Conversation

github-actions[bot]
Copy link
Contributor

@github-actions github-actions bot commented Sep 1, 2023

Backport: https://github.com/kiegroup/kogito-docs/pull/432

Note: CI is not automatically triggered on backported PRs, please comment 'ok to test' to launch Jenkins jobs

KOGITO-9460

Description: Improve KN CLI Workflow plugin guide.

Please make sure that your PR meets the following requirements:

  • You have read the contributions doc
  • Pull Request title is properly formatted: KOGITO-XYZ Subject
  • Pull Request title contains the target branch if not targeting main: [0.9.x] KOGITO-XYZ Subject
  • The nav.adoc file has a link to this guide in the proper category
  • The index.adoc file has a card to this guide in the proper category, with a meaningful description
How to backport a pull request to a different branch?

In order to automatically create a backporting pull request please add one or more labels having the following format backport-<branch-name>, where <branch-name> is the name of the branch where the pull request must be backported to (e.g., backport-7.67.x to backport the original PR to the 7.67.x branch).

NOTE: backporting is an action aiming to move a change (usually a commit) from a branch (usually the main one) to another one, which is generally referring to a still maintained release branch. Keeping it simple: it is about to move a specific change or a set of them from one branch to another.

Once the original pull request is successfully merged, the automated action will create one backporting pull request per each label (with the previous format) that has been added.

If something goes wrong, the author will be notified and at this point a manual backporting is needed.

NOTE: this automated backporting is triggered whenever a pull request on main branch is labeled or closed, but both conditions must be satisfied to get the new PR created.

* KOGITO-9460: Update KN CLI plugin guide

* KOGITO-9460: Create a new guide describing the workflow CLI

Updates the guide to include run, create, deploy and undeploy commands
without quarkus sections.
Moves quarkus section down and improves them to reflect latest changes.
Adds new additional resource that will be added later.

* KOGITO-9460: Fix quarkus CLI guides

* Update serverlessworkflow/modules/ROOT/pages/testing-and-troubleshooting/kn-plugin-workflow-overview.adoc

Co-authored-by: Kalyani Desai <[email protected]>

* Update serverlessworkflow/modules/ROOT/pages/testing-and-troubleshooting/kn-plugin-workflow-overview.adoc

Co-authored-by: Kalyani Desai <[email protected]>

* Update serverlessworkflow/modules/ROOT/pages/testing-and-troubleshooting/kn-plugin-workflow-overview.adoc

Co-authored-by: Kalyani Desai <[email protected]>

* KOGITO-9460: Remove obsolete part in deploy

* Improve /kn-plugin-workflow-overview.adoc to mention devUI auto opens

Co-authored-by: Zbyněk Drápela <[email protected]>

---------

Co-authored-by: Kalyani Desai <[email protected]>
Co-authored-by: Zbyněk Drápela <[email protected]>
Copy link
Contributor

@kaldesai kaldesai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

@MarianMacik MarianMacik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as in #482.

@ricardozanini ricardozanini merged commit a875a21 into 1.42.x Oct 5, 2023
1 check passed
@ricardozanini ricardozanini deleted the 1.42.x_KOGITO-9460 branch October 5, 2023 11:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants